This file contains API for GNSS RTK 3 EA Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
#include "drv_uart.h"

Data Structures
struct	gnssrtk3ea_s
	GNSS RTK 3 EA Click context object. More...
struct	gnssrtk3ea_cfg_t
	GNSS RTK 3 EA Click configuration object. More...

Macros
#define	GNSSRTK3EA_RSP_START "$"
	GNSS RTK 3 EA response buffer commands.
#define	GNSSRTK3EA_RSP_DELIMITER ","
#define	GNSSRTK3EA_RSP_END "\r\n"
#define	GNSSRTK3EA_RSP_GGA "GGA"
#define	GNSSRTK3EA_GGA_ELEMENT_SIZE 15
	GNSS RTK 3 EA GGA command elements.
#define	GNSSRTK3EA_GGA_TIME 1
#define	GNSSRTK3EA_GGA_LATITUDE 2
#define	GNSSRTK3EA_GGA_LATITUDE_SIDE 3
#define	GNSSRTK3EA_GGA_LONGITUDE 4
#define	GNSSRTK3EA_GGA_LONGITUDE_SIDE 5
#define	GNSSRTK3EA_GGA_QUALITY_INDICATOR 6
#define	GNSSRTK3EA_GGA_NUMBER_OF_SATELLITES 7
#define	GNSSRTK3EA_GGA_H_DILUTION_OF_POS 8
#define	GNSSRTK3EA_GGA_ALTITUDE 9
#define	GNSSRTK3EA_GGA_ALTITUDE_UNIT 10
#define	GNSSRTK3EA_GGA_GEOIDAL_SEPARATION 11
#define	GNSSRTK3EA_GGA_GEOIDAL_SEPARATION_UNIT 12
#define	GNSSRTK3EA_GGA_TIME_SINCE_LAST_DGPS 13
#define	GNSSRTK3EA_GGA_DGPS_REFERENCE_STATION_ID 14
#define	GNSSRTK3EA_I2C_SLAVE_CR_CMD 0xAA51u
	GNSS RTK 3 EA I2C settings.
#define	GNSSRTK3EA_I2C_SLAVE_CW_CMD 0xAA53u
#define	GNSSRTK3EA_I2C_SLAVE_CMD_LEN 8
#define	GNSSRTK3EA_I2C_SLAVE_RX_LEN 4
#define	GNSSRTK3EA_I2C_SLAVE_TX_LEN_REG_OFFSET 0x0008u
#define	GNSSRTK3EA_I2C_SLAVE_TX_BUF_REG_OFFSET 0x2000u
#define	GNSSRTK3EA_I2C_SLAVE_RX_LEN_REG_OFFSET 0x0004u
#define	GNSSRTK3EA_I2C_SLAVE_RX_BUF_REG_OFFSET 0x1000u
#define	GNSSRTK3EA_I2C_SLAVE_ADDRESS_CR_OR_CW 0x50
#define	GNSSRTK3EA_I2C_SLAVE_ADDRESS_R 0x54
#define	GNSSRTK3EA_I2C_SLAVE_ADDRESS_W 0x58
#define	GNSSRTK3EA_I2C_SLAVE_MAX_ERRORS 10
#define	GNSSRTK3EA_TX_DRV_BUFFER_SIZE 100
	GNSS RTK 3 EA driver buffer size.
#define	GNSSRTK3EA_RX_DRV_BUFFER_SIZE 1000u
#define	GNSSRTK3EA_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Typedefs
typedef err_t(*	gnssrtk3ea_master_io_t) (struct gnssrtk3ea_s , uint8_t , uint16_t)
typedef struct gnssrtk3ea_s	gnssrtk3ea_t
	GNSS RTK 3 EA Click context object.

Enumerations
enum	gnssrtk3ea_drv_t { GNSSRTK3EA_DRV_SEL_UART , GNSSRTK3EA_DRV_SEL_I2C }
	GNSS RTK 3 EA Click driver selector. More...
enum	gnssrtk3ea_return_value_t { GNSSRTK3EA_OK = 0 , GNSSRTK3EA_ERROR = -1 }
	GNSS RTK 3 EA Click return value data. More...

Functions
void	gnssrtk3ea_cfg_setup (gnssrtk3ea_cfg_t *cfg)
	GNSS RTK 3 EA configuration object setup function.
void	gnssrtk3ea_drv_interface_sel (gnssrtk3ea_cfg_t *cfg, gnssrtk3ea_drv_t drv_sel)
	GNSS RTK 3 EA driver interface setup function.
err_t	gnssrtk3ea_init (gnssrtk3ea_t ctx, gnssrtk3ea_cfg_t cfg)
	GNSS RTK 3 EA initialization function.
err_t	gnssrtk3ea_generic_write (gnssrtk3ea_t ctx, uint8_t data_in, uint16_t len)
	GNSS RTK 3 EA data writing function.
err_t	gnssrtk3ea_generic_read (gnssrtk3ea_t ctx, uint8_t data_out, uint16_t len)
	GNSS RTK 3 EA data reading function.
void	gnssrtk3ea_set_rst_pin (gnssrtk3ea_t *ctx, uint8_t state)
	GNSS RTK 3 EA set RST pin function.
void	gnssrtk3ea_set_cen_pin (gnssrtk3ea_t *ctx, uint8_t state)
	GNSS RTK 3 EA set CEN pin function.
void	gnssrtk3ea_set_wup_pin (gnssrtk3ea_t *ctx, uint8_t state)
	GNSS RTK 3 EA set WUP pin function.
uint8_t	gnssrtk3ea_get_pps_pin (gnssrtk3ea_t *ctx)
	GNSS RTK 3 EA get PPS pin function.
void	gnssrtk3ea_enable_device (gnssrtk3ea_t *ctx)
	GNSS RTK 3 EA enable device function.
void	gnssrtk3ea_disable_device (gnssrtk3ea_t *ctx)
	GNSS RTK 3 EA disable device function.
void	gnssrtk3ea_reset_device (gnssrtk3ea_t *ctx)
	GNSS RTK 3 EA reset device function.
err_t	gnssrtk3ea_parse_gga (uint8_t rsp_buf, uint8_t gga_element, uint8_t element_data)
	GNSS RTK 3 EA parse GGA function.

Detailed Description

This file contains API for GNSS RTK 3 EA Click Driver.

Typedef Documentation

◆ gnssrtk3ea_master_io_t

typedef err_t(* gnssrtk3ea_master_io_t) (struct gnssrtk3ea_s *, uint8_t *, uint16_t)

Driver serial interface.

◆ gnssrtk3ea_t

typedef struct gnssrtk3ea_s gnssrtk3ea_t

GNSS RTK 3 EA Click context object.

Context object definition of GNSS RTK 3 EA Click driver.

Enumeration Type Documentation

◆ gnssrtk3ea_drv_t

enum gnssrtk3ea_drv_t

GNSS RTK 3 EA Click driver selector.

Selects target driver interface of GNSS RTK 3 EA Click driver.

Enumerator
GNSSRTK3EA_DRV_SEL_UART	UART driver descriptor.
GNSSRTK3EA_DRV_SEL_I2C	I2C driver descriptor.

◆ gnssrtk3ea_return_value_t

enum gnssrtk3ea_return_value_t

GNSS RTK 3 EA Click return value data.

Predefined enum values for driver return values.

Enumerator
GNSSRTK3EA_OK
GNSSRTK3EA_ERROR

Data Structures

Macros

Typedefs

Enumerations